Güzel adlandırma, yazılım geliştirme ve diğer alanlarda nesnelere, değişkenlere, fonksiyonlara ve diğer öğelere anlamlı ve tutarlı isimler verme pratiğidir. İyi adlandırılmış öğeler, kodun okunabilirliğini ve anlaşılabilirliğini artırır, böylece geliştirme sürecini hızlandırır ve hataları azaltır.
Güzel adlandırmanın temel prensipleri:
- Açıklayıcı Olmak: İsimler, öğenin amacını veya işlevini açıkça belirtmelidir. Örneğin,
calculateTotalPrice fonksiyonu, toplam fiyatı hesapladığını belirtir.
- Tutarlı Olmak: Proje genelinde aynı terminoloji ve adlandırma kuralları kullanılmalıdır. Örneğin, değişkenler için
camelCase kullanılırken, sınıflar için PascalCase kullanılabilir.
- Anlaşılır Olmak: İsimler, genel olarak kabul görmüş terimleri ve kısaltmaları kullanmalıdır. Belirsiz veya karmaşık kısaltmalardan kaçınılmalıdır.
- Kısa ve Öz Olmak: İsimler, gereksiz ayrıntılardan kaçınarak kısa ve öz olmalıdır. Ancak, açıklayıcılıktan ödün verilmemelidir.
- Alan Adına Uygun Olmak: İsimler, öğenin ait olduğu alan veya bağlam ile ilgili olmalıdır. Örneğin, bir kullanıcı arayüzü öğesi için
usernameInput gibi bir isim kullanılabilir.
Güzel adlandırmanın faydaları:
- Okunabilirlik: İyi adlandırılmış kod, daha kolay okunur ve anlaşılır hale gelir.
- Bakım Kolaylığı: Anlamlı isimler, kodun bakımını ve güncellenmesini kolaylaştırır.
- Hata Ayıklama: Açıklayıcı isimler, hataların daha hızlı bulunmasına ve düzeltilmesine yardımcı olur.
- Ekip Çalışması: Tutarlı adlandırma kuralları, ekip üyelerinin birlikte daha verimli çalışmasını sağlar.
- Kodun Yeniden Kullanılabilirliği: İyi adlandırılmış kod, daha kolay yeniden kullanılabilir hale gelir.
Örnekler:
- Kötü:
x, data, temp
- İyi:
customerName, orderTotal, temporaryFile
İlgili Kavramlar: